home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 4 / Gold Medal Software - Volume 4 (Gold Medal) (1994).iso / os2 / mdf121.arj / MDFL121.ZIP / MDFL_ENG.DOC < prev    next >
Text File  |  1994-06-07  |  4KB  |  98 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                       MDFLIB
  8.                                    Version 1.21
  9.  
  10.                            (C) 1994/95 Maurizio Giunti
  11.  
  12.  
  13.        C++ library to apply *.MDF patch  files produced with a REGISTERED
  14.        copy of  MDIFF/MDIFF2.  Both  Dos and  OS/2  2.xx  32bits verions.
  15.        MDFLIB is totally free of charge, and royalty free. Anyone can re-
  16.        distribute MDFLIB, but only  if he/she asks back  no money, except
  17.        for copy and/or shipping expenses (anyway,  these expenses must be
  18.        carefully documented). Another  condition that you  must follow to
  19.        distribute it is  to furnish  the ORIGINAL packet  always, without
  20.        any modifications.
  21.  
  22.        WARNING:
  23.        MDFLIB will work  ONLY on *.MDF  files produced  with a REGISTERED
  24.        copy of MDIFF/MDIFF2.
  25.  
  26.  
  27.        MPatch class
  28.        To use this class is not important to know how it operates or what
  29.        it contains;  but  is  very important  understand  how  its public
  30.        members operate.
  31.  
  32.        MPatch()
  33.        MPatch() is the class constructor. Its function is to initialize
  34.        private data.
  35.  
  36.        void SetRate(short r)
  37.        SetRate() changes the frequency of calling of Show().
  38.  
  39.        short MDFPatch(char *dif, char *old, char *new)
  40.        This is the  main function.  Its parameters are  the name  of .MDF
  41.        file, the name of  the file to patch  and the name of  the fito it
  42.        must create.Warning: old and  new must not  contain equal strings.
  43.        If old and  new are empty  strings ("\0") MDFPatch()  will use the
  44.        names contained in the  .MDF file. The function  must return 0 or,
  45.        in case of error a non-0 value. Please, see later for details.
  46.  
  47.        char *LastError()
  48.        If there was errors in using MDFPatch() function, LastError()
  49.        will return a pointer to a string that explain the error.
  50.  
  51.        void Show_start()
  52.        void Show()
  53.        void Show_end()
  54.        These 3  functions  are  useful  to  show  messages  during  patch
  55.        application.  Show_start()  will  be   automatically  called  from
  56.        MDFPatch() before to start in applying the patch. In the same way,
  57.        Show_end() will be  called at  the end of  the process.  Show() is
  58.        called during the process at a  frequency dependent from the value
  59.        setted with SetRate().These 3  functions are virtual,  so you must
  60.        inherit MPatch class to  change them. See the  SAMPLE.CPP for more
  61.        details.
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.        Error table
  69.        MDFPatch() returns values are defined as follows:
  70.  
  71.           Numeric               Alphabetic string
  72.            code
  73.              0      "OK!"
  74.              1      "Out of memory !"
  75.              2      "Can't open MDF file !"
  76.              3      "Invalid MDF file !"
  77.              4      "MDF file version mismatch !"
  78.              5      "UNREGISTERED !"
  79.              6      "Bad or incorrect OLD file !"
  80.              7      "Can't open OLD file !"
  81.              8      "Can't create NEW file !"
  82.              9      "General failure: NEW file corrupted !"
  83.             10      "OLD and NEW can't be the same file !"
  84.  
  85.  
  86.  
  87.        For any question you can contact me at:
  88.  
  89.        My home address:
  90.                                  Maurizio Giunti
  91.                                Via G.B. Foggini, 24
  92.                                   50142 Firenze
  93.                                       Italy
  94.  
  95.  
  96.        My E-Mail address:
  97.                                Fidonet: 2:332/102.3
  98.                         Internet: Giunti@stat.ds.unifi.it